/*
 * SonarQube
 * Copyright (C) 2009-2024 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
import { WebApi } from '../../types/types';

export function mockAction(overrides: Partial<WebApi.Action> = {}): WebApi.Action {
  return {
    key: 'action1',
    internal: false,
    changelog: [],
    description: 'Action 1',
    hasResponseExample: false,
    post: false,
    ...overrides,
  };
}

export function mockDomain(overrides: Partial<WebApi.Domain> = {}): WebApi.Domain {
  return {
    actions: [mockAction()],
    description: 'foo',
    path: 'foo/bar',
    since: '1.0',
    ...overrides,
  };
}

export function mockParam(overrides: Partial<WebApi.Param> = {}): WebApi.Param {
  return {
    key: 'p1',
    description: 'parameter 1',
    internal: false,
    required: false,
    ...overrides,
  };
}
